<?php

namespace PHPExcel\Style;

/**
 * PHPExcel_Style_Conditional
 *
 * Copyright (c) 2006 - 2015 PHPExcel
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * @category PHPExcel
 * @package PHPExcel_Style
 * @copyright Copyright (c) 2006 - 2015 PHPExcel (http://www.codeplex.com/PHPExcel)
 * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
 * @version ##VERSION##, ##DATE##
 */
class Conditional implements \PHPExcel\IComparable {
    /* Condition types */
    const CONDITION_NONE = 'none';
    const CONDITION_CELLIS = 'cellIs';
    const CONDITION_CONTAINSTEXT = 'containsText';
    const CONDITION_EXPRESSION = 'expression';
    
    /* Operator types */
    const OPERATOR_NONE = '';
    const OPERATOR_BEGINSWITH = 'beginsWith';
    const OPERATOR_ENDSWITH = 'endsWith';
    const OPERATOR_EQUAL = 'equal';
    const OPERATOR_GREATERTHAN = 'greaterThan';
    const OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual';
    const OPERATOR_LESSTHAN = 'lessThan';
    const OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual';
    const OPERATOR_NOTEQUAL = 'notEqual';
    const OPERATOR_CONTAINSTEXT = 'containsText';
    const OPERATOR_NOTCONTAINS = 'notContains';
    const OPERATOR_BETWEEN = 'between';
    
    /**
     * Condition type
     *
     * @var int
     */
    private $conditionType;
    
    /**
     * Operator type
     *
     * @var int
     */
    private $operatorType;
    
    /**
     * Text
     *
     * @var string
     */
    private $text;
    
    /**
     * Condition
     *
     * @var string[]
     */
    private $condition = array();
    
    /**
     * Style
     *
     * @var \PHPExcel\Style
     */
    private $style;
    
    /**
     * Create a new Conditional
     */
    public function __construct() {
        // Initialise values
        $this->conditionType = self::CONDITION_NONE;
        $this->operatorType = self::OPERATOR_NONE;
        $this->text = null;
        $this->condition = array();
        $this->style = new \PHPExcel\Style(false, true);
    }
    
    /**
     * Get Condition type
     *
     * @return string
     */
    public function getConditionType() {
        return $this->conditionType;
    }
    
    /**
     * Set Condition type
     *
     * @param string $pValue
     *            Condition type
     * @return Conditional
     */
    public function setConditionType($pValue = self::CONDITION_NONE) {
        $this->conditionType = $pValue;
        return $this;
    }
    
    /**
     * Get Operator type
     *
     * @return string
     */
    public function getOperatorType() {
        return $this->operatorType;
    }
    
    /**
     * Set Operator type
     *
     * @param string $pValue
     *            Conditional operator type
     * @return Conditional
     */
    public function setOperatorType($pValue = self::OPERATOR_NONE) {
        $this->operatorType = $pValue;
        return $this;
    }
    
    /**
     * Get text
     *
     * @return string
     */
    public function getText() {
        return $this->text;
    }
    
    /**
     * Set text
     *
     * @param string $value            
     * @return Conditional
     */
    public function setText($value = null) {
        $this->text = $value;
        return $this;
    }
    
    /**
     * Get Condition
     *
     * @deprecated Deprecated, use getConditions instead
     * @return string
     */
    public function getCondition() {
        if (isset($this->condition[0])) {
            return $this->condition[0];
        }
        
        return '';
    }
    
    /**
     * Set Condition
     *
     * @deprecated Deprecated, use setConditions instead
     * @param string $pValue
     *            Condition
     * @return Conditional
     */
    public function setCondition($pValue = '') {
        if (!is_array($pValue)) {
            $pValue = array(
            $pValue 
            );
        }
        
        return $this->setConditions($pValue);
    }
    
    /**
     * Get Conditions
     *
     * @return string[]
     */
    public function getConditions() {
        return $this->condition;
    }
    
    /**
     * Set Conditions
     *
     * @param string[] $pValue
     *            Condition
     * @return Conditional
     */
    public function setConditions($pValue) {
        if (!is_array($pValue)) {
            $pValue = array(
            $pValue 
            );
        }
        $this->condition = $pValue;
        return $this;
    }
    
    /**
     * Add Condition
     *
     * @param string $pValue
     *            Condition
     * @return Conditional
     */
    public function addCondition($pValue = '') {
        $this->condition[] = $pValue;
        return $this;
    }
    
    /**
     * Get Style
     *
     * @return \PHPExcel\Style
     */
    public function getStyle() {
        return $this->style;
    }
    
    /**
     * Set Style
     *
     * @param \PHPExcel\Style $pValue            
     * @throws \PHPExcel\Exception
     * @return Conditional
     */
    public function setStyle(\PHPExcel\Style $pValue = null) {
        $this->style = $pValue;
        return $this;
    }
    
    /**
     * Get hash code
     *
     * @return string Hash code
     */
    public function getHashCode() {
        return md5($this->conditionType . $this->operatorType . implode(';', $this->condition) . $this->style->getHashCode() . __CLASS__);
    }
    
    /**
     * Implement PHP __clone to create a deep clone, not just a shallow copy.
     */
    public function __clone() {
        $vars = get_object_vars($this);
        foreach ( $vars as $key => $value ) {
            if (is_object($value)) {
                $this->$key = clone $value;
            } else {
                $this->$key = $value;
            }
        }
    }
}
